Appointment Management API - TMF646
API Data Dictionary - Repair - POST appointment
API Request Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| appointmentType |
Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| category | Repair | It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| externalId | 432113 | A Partners reference Id. Part of Standard TMF646 spec. |
| description | Fix an internet connection problem for a customer | Short free text describing the appointment. Part of Standard TMF646 spec. |
| validFor | ||
| validFor\startDateTime | 2025-02-15T08:00:00.000Z | Timestamp of the start time of the time period for the appointment to start. |
| validFor\endDateTime | 2025-02-18T08:00:00.000Z | Timestamp of the end time of the time period for the appointment to start. |
| relatedEntity | See relatedEntity table |
array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product |
| @type | PXCAppointment | |
| @baseType | Appointment |
API Response Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| id | APP1234 | Unique identifier of the appointment. A PXC reference. |
| href | /appointment/{id} | The URI of the resource. |
| category | Repair | It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| externalId | 432113 | A Partner’s reference Id. Part of Standard TMF646 spec. |
| supplierAppointmentId | Extension | Extension to the API. Unique supplier reference appointment. A value generated when Openreach creates an Aline appointment. |
| openreachAppointmentId | 1234 | Extension to the API. Unique Openreach reference for scheduling an appointment. A Fiber Cable reference. |
| description | Fix an internet connection problem for a customer | Short free text describing the appointment. Part of Standard TMF646 spec. |
| creationDate | 2025-02-01T14:48:45.071Z | Timestamp of the appointment creation date. |
| lastUpdate | 2025-02-01T14:48:45.071Z | Timestamp of the last time Appointment was updated. |
| status | scheduled | Status of the Appointment. Will be set to scheduled. |
| requestedExecutionDate | 2025-02-01T14:48:45.071Z | Extension to the API. Timestamp until which appointment transaction will be scheduled. It means we are asking Openreach to schedule the appointment before this date. |
| validFor | Time interval appointment is valid for. | |
| validFor\startDateTime | 2025-02-15T08:00:00.000Z | Timestamp of the start time of the appointment. (UTC timestamp) |
| validFor\endDateTime | 2025-02-18T08:00:00.000Z | Timestamp of the end time of the appointment. |
| relatedEntity | See relatedEntity table |
array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product |
| @type | PXCAppointment | |
| @baseType | Appointment |